Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Model generator USAGE doc improvement #10092

Merged
merged 1 commit into from Apr 5, 2013
Merged

Conversation

smathy
Copy link
Contributor

@smathy smathy commented Apr 4, 2013

This started with me noticing that the default option mentioned in the help docs for rails g model didn't actually work. I removed that, and improved the docs for the other options:

  • Added information about syntax for precision/scale of decimals
  • Removed incorrect information about being able to set default
  • Added more examples of usage


`rails generate model user pseudo:string{30}`
`rails generate model user pseudo:string:uniq`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'd be good to have a :index option here too.

@carlosantoniodasilva
Copy link
Member

Looks good, just minor comments. Thanks.

@smathy
Copy link
Contributor Author

smathy commented Apr 4, 2013

Yeah, sorry, I read that as "Then you can" 10 times. I have those fixes ready, should I just push a second commit? Or you guys want them squashed into a single commit? I don't remember the preference.

@smathy
Copy link
Contributor Author

smathy commented Apr 4, 2013

I went ahead and pushed a new commit, let me know if you want it squashed instead.

@carlosantoniodasilva
Copy link
Member

Usually they should be squashed because they related to the same change. If
they were two different changes then having different commits would be ok.
Thanks.

On Thu, Apr 4, 2013 at 4:17 PM, Jason King notifications@github.com wrote:

Yeah, sorry, I read that as "Then you can" 10 times. I have those fixes
ready, should I just push a second commit? Or you guys want them squashed
into a single commit? I don't remember the preference.


Reply to this email directly or view it on GitHubhttps://github.com//pull/10092#issuecomment-15917769
.

At.
Carlos Antonio

@steveklabnik
Copy link
Member

I do the same thing all the time: I recently submitted some docs to Rust that had THREE ROUNDS of typos.

 * Added information about syntax for precision/scale of decimals
 * Removed incorrect information about being able to set `default`
 * Added more examples of usage
@smathy
Copy link
Contributor Author

smathy commented Apr 4, 2013

Done, thanks.

carlosantoniodasilva added a commit that referenced this pull request Apr 5, 2013
Model generator USAGE doc improvement
@carlosantoniodasilva carlosantoniodasilva merged commit 9e4c25e into rails:master Apr 5, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants